6  Anhang

6.1 README-Datei für GitHub-Repository: README.md

# Project Name - Dataset

## Overview
This repository contains the dataset used in the research article:  
**"Title of the Paper"**, published in *Journal Name*.  
DOI of the article: [Link to Paper DOI]  

## Dataset Description
- **Raw Data**: `/raw_data/` contains the original data collected during the study.  
- **Processed Data**: `/processed_data/` contains cleaned and analyzed data.  
- **Scripts**: `/scripts/` includes scripts used for data analysis.

## How to Use
1. Clone this repository: `git clone https://github.com/username/projectname-dataset.git`
2. Navigate through the folders for relevant files.  
3. Refer to `metadata.txt` for detailed descriptions of the dataset and methodology.

## Citation
If you use this dataset, please cite:  
- **Dataset**: [DOI provided by Zenodo]  
- **Paper**: [Paper DOI]

## License
This dataset is licensed under [LICENSE NAME]. See `LICENSE` file for details.

6.2 Datenmanagementplan: DMP.md

# Datenmanagementplan (DMP)

## 1. Projektbeschreibung
**Projektname**: [Titel des Forschungsprojekts]  
**Verantwortliche*r Forschende*r**: [Ihr Name]  
**Institution**: [Name der Hochschule oder Forschungseinrichtung]  
**Förderorganisation (falls zutreffend)**: [Förderorganisation, z. B. DFG]  

### Ziel des Projekts
[Kurze Beschreibung des Projekts, z. B.:  
"Dieses Projekt untersucht [Thema]. Die generierten Daten dienen als Grundlage für die Publikation im Journal [Name] und werden gemäß den FAIR-Prinzipien öffentlich zugänglich gemacht."]

## 2. Arten und Umfang der Daten
**Datentypen**:  
- [Primärdaten, z. B. experimentelle Messdaten, Umfrageergebnisse, Bilddaten]  
- [Sekundärdaten, z. B. aus Literatur oder externen Datenquellen]  
- [Metadaten, z. B. Dokumentation, Kontextbeschreibungen]  

**Umfang der Daten**:  
- Geschätzte Dateigröße: [z. B. 500 MB]  
- Anzahl der Dateien: [z. B. 30 CSV-Dateien]  

**Dateiformate**:  
- Rohdaten: [z. B. CSV, TIFF]  
- Analysedaten: [z. B. XLSX, JSON]  
- Dokumentation: [z. B. Markdown, PDF]

## 3. Speicherung und Sicherung
**Speicherorte**:  
- **Primäre Speicherung**: GitHub-Repository ([Link hinzufügen])  
- **Backup-Strategie**: Automatische Sicherung auf lokalen Systemen, Cloud-Diensten (z. B. [Google Drive, OneDrive]), o.a.  

**Versionierung**:  
- Git wird zur Versionierung und Nachverfolgung von Änderungen verwendet.

**Zugriffsrechte während des Projekts**:  
- Nur Projektbeteiligte haben während der Erstellung Schreibrechte.  
- GitHub ermöglicht eine öffentliche Einsicht nach Abschluss des Projekts.

## 4. Dokumentation und Metadaten
**Metadatenformat**:  
- [z. B. DataCite, Dublin Core]  

**Beschreibung der Daten**:  
- Jede Datei wird durch eine README-Datei dokumentiert, die Informationen über:  
   - Den Inhalt  
   - Die Erhebungsmethodik  
   - Verwendete Software oder Tools enthält.
- Schlagwörter: [Themenrelevante Begriffe, z. B. "Machine Learning", "Umweltdaten"]  

**DOI-Zuweisung**:  
- Die Veröffentlichung erfolgt mit einem DOI über Zenodo.

## 5. Veröffentlichung und Nachnutzung
**Geplante Veröffentlichung**:  
- Veröffentlichung auf GitHub und Zenodo nach Akzeptanz des zugehörigen Papers.  

**Lizenzierung**:  
- CC-BY 4.0 empfohlen für maximale Nachnutzung  
- (Alternativen: CC-BY-NC 4.0, CC0, MIT-Lizenz)

**Zugänglichkeit**:  
- Die Daten sind über Zenodo öffentlich zugänglich (Open Access).  
- Der DOI garantiert die dauerhafte Verfügbarkeit.  
- Einschränkungen des Zugriffs werden über Embargo-Status Optionen von Zenodo geregelt.

**Interoperabilität:**  
- Daten werden in offenen Formaten gespeichert (siehe Abschnitt 2, Arten und Umfang der Daten)
- Metadaten-Standards: DataCite für Beschreibung und DOI-Referenzierung  
- Ontologien oder kontrollierte Vokabulare zur Standardisierung von Begriffen: Verwendung von [z. B. MeSH, AGROVOC] 

**Wiederverwendbarkeit:**  
- Lizenz: [z. B. MIT, erlaubt die Nachnutzung auch in proprietärer Software unter der Bedingung der Namensnennung]  
- Vollständige Dokumentation der Daten: [Methoden, Kontext, verwendete Software wie z. B. Python-Skripte mit spezifischen Bibliotheksversionen]
- Anleitungen für die Nachnutzung: [z. B. siehe README-Datei]


**Langfristige Archivierung**:  
- Zenodo garantiert die Archivierung für mindestens 20 Jahre.

## 6. Verantwortlichkeiten und Ressourcen
**Datenverantwortliche/r**:  
- [Ihr Name]  

**Zusätzliche Ressourcen**:  
- Genutzte Software: [z. B. Python, R]  
- Infrastruktur: GitHub, Zenodo.  

## 7. Ethik und Datenschutz
**Datenschutzanforderungen**:  
- Keine personenbezogenen Daten enthalten.  
- Sensible Daten wurden entfernt oder anonymisiert.  

**Ethikfreigaben**:  
- Nicht erforderlich. (Alternative: "Wurde durch die Ethikkommission genehmigt am [Datum].") 

## 8. Aktualisierungen des Plans
**Versionierung des DMP**:  
- Initiale Version: [Datum]  
- Geplante Überprüfung: [z. B. alle 6 Monate oder nach Projektmeilensteinen]

6.3 Checkliste der FAIR-Prinzipien: FAIR.md

# FAIR-Checkliste für GitHub & Zenodo

## Findable (Auffindbar)
- [ ] **F1**: Der Datensatz hat eine eindeutige und dauerhafte **DOI** (z. B. von Zenodo).  
- [ ] **F2**: Metadaten enthalten einen klaren, beschreibenden **Titel** und **Schlüsselwörter**.  
- [ ] **F3**: Der Datensatz ist in einem **offenen Repository** (GitHub & Zenodo) gespeichert.  
- [ ] **F4**: Metadaten sind **durchsuchbar** (z. B. über Zenodo-Suchfunktionen).  

## Accessible (Zugänglich)
- [ ] **A1**: Der Datensatz ist über eine **öffentliche URL** abrufbar.  
- [ ] **A1.1**: Daten und Metadaten sind auch nach Ablauf des Projekts verfügbar (Zenodo sichert dies). 
- [ ] **A1.2**: **Metadaten bleiben abrufbar**, auch wenn die Daten entfernt wurden.  
- [ ] **A2**: Falls Zugriffsbeschränkungen bestehen, sind diese klar dokumentiert.  

## Interoperable (Interoperabel)
- [ ] **I1**: Datensatz und Metadaten nutzen **offene, standardisierte Formate** (z. B. CSV, JSON, Markdown).  
- [ ] **I2**: Metadaten enthalten **kontrollierte Vokabulare** oder **standardisierte Begriffe** (z. B. ORCID für Autoren).  
- [ ] **I3**: Der Datensatz verlinkt relevante **Publikationen, Software oder andere Daten**.  

## Reusable (Nachnutzbar)
- [ ] **R1**: Metadaten enthalten eine **klare Lizenz** (z. B. CC-BY 4.0 oder MIT für Code).  
- [ ] **R1.1**: Der Datenmanagementplan (DMP) beschreibt den Datensatz präzise.  
- [ ] **R1.2**: Der Datensatz enthält eine detaillierte **README.md** zur Nutzung.  
- [ ] **R1.3**: Die Datenquelle, Entstehung und Verarbeitungsschritte sind dokumentiert (z. B. in der README oder im DMP).  

**Tipp:** Halte die README.md und Metadaten aktuell, um die FAIR-Prinzipien langfristig zu gewährleisten.  

6.4 Beispiel für ein Changelog: CHANGELOG.md

Legen Sie die Datei CHANGELOG.md auf derselben Ordnerebene wie README.md an:

# Changelog

## v1.1.0 - 2025-01-10
- Hinzugefügt: Neue Datenpunkte für [Experiment XYZ].
- Geändert: Erweiterung der README mit zusätzlichen Analyseschritten.

## v1.0.1 - 2024-12-20
- Behoben: Fehler in den Variablenbeschreibungen.

## v1.0.0 - 2024-12-01
- Initiale Veröffentlichung des Datensatzes.

6.5 README-Datei für GitHub-Repository: README.md

Beispiel: Metadaten dieses Dokuments als DataCite JSON generiert von Zenodo:

{
  "creators": [
    {
      "familyName": "sgudenkauf",
      "name": "sgudenkauf",
      "nameIdentifiers": [],
      "nameType": "Personal"
    }
  ],
  "dates": [
    {
      "date": "2025-02-10",
      "dateType": "Issued"
    },
    {
      "date": "2025-02-10",
      "dateType": "Updated"
    }
  ],
  "descriptions": [
    {
      "description": "Updated Acknowledgments.",
      "descriptionType": "Abstract"
    }
  ],
  "identifiers": [
    {
      "identifier": "https://zenodo.org/records/14843008",
      "identifierType": "URL"
    },
    {
      "identifier": "10.5281/zenodo.14843008",
      "identifierType": "DOI"
    },
    {
      "identifier": "oai:zenodo.org:14843008",
      "identifierType": "oai"
    }
  ],
  "publicationYear": "2025",
  "publisher": "Zenodo",
  "relatedIdentifiers": [
    {
      "relatedIdentifier": "https://github.com/sgudenkauf/quarto-simple-rdm-tutorial/tree/v1.0.3",
      "relatedIdentifierType": "URL",
      "relationType": "IsSupplementTo",
      "resourceTypeGeneral": "Software"
    },
    {
      "relatedIdentifier": "10.5281/zenodo.14840823",
      "relatedIdentifierType": "DOI",
      "relationType": "IsVersionOf"
    },
    {
      "relatedIdentifier": "https://archive.softwareheritage.org/swh:1:dir:fb7dfefa8b9645de237e4eb431fb42c4c331c570;origin=https://doi.org/10.5281/zenodo.14840823;visit=swh:1:snp:e214173932653196d0d9994894ae4045823a443c;anchor=swh:1:rel:02f5937d89e2a1bb94faaf03a5135308a813b4ce;path=sgudenkauf-quarto-simple-rdm-tutorial-2258c18",
      "relatedIdentifierType": "URL",
      "relationType": "IsIdenticalTo"
    }
  ],
  "rightsList": [
    {
      "rights": "MIT License",
      "rightsIdentifier": "mit",
      "rightsIdentifierScheme": "spdx",
      "rightsUri": "https://opensource.org/licenses/MIT"
    }
  ],
  "schemaVersion": "http://datacite.org/schema/kernel-4",
  "titles": [
    {
      "title": "sgudenkauf/quarto-simple-rdm-tutorial: v1.0.3"
    }
  ],
  "types": {
    "resourceType": "",
    "resourceTypeGeneral": "Software"
  },
  "version": "v1.0.3"
}

Beispiel: Metadaten dieses Dokuments als Dublin Core XML generiert von Zenodo:

<?xml version='1.0' encoding='utf-8'?>
<oai_dc:dc xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd">
  <dc:creator>sgudenkauf</dc:creator>
  <dc:date>2025-02-10</dc:date>
  <dc:description>&amp;lt;p&amp;gt;Updated Acknowledgments.&amp;lt;/p&amp;gt;</dc:description>
  <dc:identifier>https://doi.org/10.5281/zenodo.14843008</dc:identifier>
  <dc:identifier>oai:zenodo.org:14843008</dc:identifier>
  <dc:publisher>Zenodo</dc:publisher>
  <dc:relation>https://github.com/sgudenkauf/quarto-simple-rdm-tutorial/tree/v1.0.3</dc:relation>
  <dc:relation>https://doi.org/10.5281/zenodo.14840823</dc:relation>
  <dc:rights>info:eu-repo/semantics/openAccess</dc:rights>
  <dc:rights>MIT License</dc:rights>
  <dc:rights>https://opensource.org/licenses/MIT</dc:rights>
  <dc:title>sgudenkauf/quarto-simple-rdm-tutorial: v1.0.3</dc:title>
  <dc:type>info:eu-repo/semantics/other</dc:type>
</oai_dc:dc>

6.6 Verwendete Softwarewerkzeuge

Zur Erstellung dieses Leitfadens haben wir verschiedene Softwarewerkzeuge vrewendet. Deren Gebrauch dokumentieren wir gemäß Baresel u. a. (2024). Genannt werden der Name des Werkzeugs, Quelle, Verwendungszweck und Anwendungsbereich.1 Die Angaben sollten den Empfehlungen des APA-Stils für die Angabe von Softwareversionen entsprechen.

  1. OpenAI. (2023). ChatGPT (Version 14. März) [Großes Sprachmodell]. https://chat.openai.com2

    • Übersetzung deutsch/englisch (Abstract)

    • Generieren von Vorschlägen für Markdown-Vorlagen (Anhang, Kapitel 3)

    • Generieren von Vorschlägen zu Vorgehen und Struktur (gesamtes Dokument)

  2. Microsoft Corporation. (2024). Visual Studio Code (Version 1.96.2) [Quelltext-Editor]. https://code.visualstudio.com

    • Editor zum Schreiben der Quelldateien (gesamtes Projekt)
  3. Posit, PBC. (2024). Quarto (Version 1.118.0) [Dokumentations- und Publishing-Software]. https://quarto.org

    • Übersetzen der Quelldateien in Webseite und PDF-Dokument, siehe Verzeichnis docs/ (gesamtes Projekt)
  4. Posit, PBC. (2024). Quarto Extension for Visual Studio Code (Version 1.6.39) [Software-Erweiterung]. https://quarto.org/docs/tools/vscode.html

    • Komfortable Bedienung von Quarto aus Visual Studio Code heraus (gesamtes Projekt)

    • Quarto-Syntaxunterstützung (gesamtes Projekt)


  1. Wir verzichten auf die zusätzliche Nennung der “genutzten Funktion” gemäß Baresel u. a. (2024), da sie sich aus unserer Sicht mit dem Vewendungszweck doppelt. Siehe auch Tabelle 2 in Baresel u. a. (2024).↩︎

  2. Die genaue Versionsnummer von ChatGPT ist nicht öffentlich zugänglich. Wir verwenden daher das Datum der letzten Aktualisierung als Versionsbezeichnung.↩︎